home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bs200.zip / BISEARCH.DOC < prev    next >
Text File  |  1992-04-02  |  13KB  |  326 lines
  1.  
  2.            ======================= BISEARCH ========================
  3.  
  4.                  The original Searchlight to BiModem Interface
  5.  
  6.                 Copyright(C) 1992 BiBass Software, by Kevin Bass
  7.                               ALL RIGHTS RESERVED.
  8.  
  9.                  Created with Searchlight Programmer's Library
  10.                 Portions Copyright(C) 1991 Searchlight Software
  11.  
  12.  
  13.     - WHAT IS BISEARCH
  14.  
  15.     BISEARCH makes BiModem  and Searchlight almost a 100% compatible.  What
  16.     do I mean   by  almost?  Searchlight  does  not  allow passwords to be
  17.     decrypted.  Therefore, BISEARCH  can   not   write previously protected
  18.     files and their correct passwords to BiModem's password file.  However,
  19.     any files uploaded  with passwords  with  BiModem via  BISEARCH will be
  20.     added correctly to BiModem's password file.
  21.  
  22.  
  23.  
  24.  
  25.     - BISEARCH FEATURES
  26.  
  27.     Before I list some of BISEARCH's features,  let me familiarize you with
  28.     BiModem.
  29.  
  30.     BiModem allows simultaneous  bidirectional file transfers.  Imagine the
  31.     time savings if   you   could   upload   with  Zmodem(tm)  and Ymodem-G
  32.     efficiencies while downloading  at the same  efficiency simultaneously.
  33.     If that excites you, how about the ability to chat while  the  transfer
  34.     is going on?    How  about adding file request while transferring other
  35.     files?  How about killing single requests on either the send or receive
  36.     side?  All this at the same time!
  37.  
  38.     BiModem allows you  to  create a large   list  of  upload  and download
  39.     requests before you  sign  on  a  bulletin   board system.   File level
  40.     password protection is available.  When someone uploads a file to a BBS
  41.     they also can  supply  a  password  so that subsequent callers can only
  42.     access the file   if  they know the correct  password.   They  also can
  43.     supply descriptions for files they upload.
  44.  
  45.     These are just  a  few  of BiModem's features.  Read the  documentation
  46.     that comes with BiModem for more features.
  47.  
  48.  
  49.     Now here are a few of BISEARCH's features:
  50.  
  51.     *  Updates users  stats.   Correctly updates the user's upload/download
  52.        kilobytes and count even if they  upload  and  download  at the same
  53.        time.
  54.  
  55.     *  File directory protection.  Users are only allowed to transfer files
  56.        to and from directories they have access to.
  57.  
  58.     *  Download/upload ratio  checking.  If a user's download/upload  ratio
  59.        has been   exceeded,  they   will  only  be allowed to upload files,
  60.        even if they have requested downloads.
  61.  
  62.  
  63.  
  64.                                      Page 1
  65.       BISEARCH - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  66.  
  67.     *  Adds uploaded  file(s)  to  file  database.   The user will be asked
  68.        what directory they would like  to  upload  to  before  the transfer
  69.        starts.  Uploads  will  only  be allowed to directories   they  have
  70.        access to.   After  the  BiModem transfer is complete, BISEARCH will
  71.        add the  file, password (if provided),  description  (if  provided),
  72.        file size,  date  uploaded,  and  the  owner  of  the  file  to  the
  73.        directories database.   If  your system places a default password on
  74.        files, BiSearch will recognize this.  Default passwords override any
  75.        passwords the user provides with their file.
  76.  
  77.     *  Prompts for  descriptions.    The   user   will   be   prompted  for
  78.        descriptions if they are not provided.
  79.  
  80.     *  New file listing.  BISEARCH will  allow  the  user  to check for new
  81.        files uploaded since their last log on.  This way they can tag files
  82.        they want to download using BiModem's BIHOT program.
  83.  
  84.     *  Time out and time limit checking.  BISEARCH will  detect  if  a user
  85.        has been sitting idle for too long.  The idle time is read from your
  86.        BBS configuration file (CONFIG.SL2).  It also continually  checks to
  87.        see if  the user's time limit has been reached.   Users  are  warned
  88.        when they have 5 minutes or less remaining.  The user's time left is
  89.        passed to BiModem before the transfers take place.
  90.  
  91.     *  Updates FILES.LOG.  BISEARCH will update your file activity log with
  92.        transfers done  with  BISEARCH.    Even   if   the  user uploads and
  93.        downloads at the same time!
  94.  
  95.     *  Checks for duplicate files.  Users  will  not  be  allowed to upload
  96.        files that already exist.
  97.  
  98.     *  Checks for aborted transfers.  If  a transfer is aborted, the user's
  99.        upload/download stats are not updated for that file.   They are only
  100.        charged for  successful  transfers.   Yes, they are not credited for
  101.        incomplete transfers!
  102.  
  103.     *  Multi-tasker aware.  BISEARCH will  write to the virtual screen if a
  104.        supported multi-tasker   is  detected.  It will give  up time slices
  105.        while waiting for user input.
  106.  
  107.     *  Searchlight style  menus.  BISEARCH was designed to look internal to
  108.        Searchlight Software.
  109.  
  110.                                  AND MUCH MORE!
  111.  
  112.  
  113.  
  114.     - BISEARCH ARCHIVE FILE CONTENTS
  115.  
  116.     The BISEARCH package consists of six  disk  files.   Make sure you have
  117.     them:
  118.                           (x's donate version number)
  119.  
  120.     BSxxx.EXE     - The executable file.
  121.     BISEARCH.DOC  - Basic instruction manual for BISEARCH.
  122.     BISEARCH.KEY  - KEY file needed to run BISEARCH.
  123.     BISEARCH.HLP  - Help file for BISEARCH.
  124.     BIMODEM.CFG   - Sample BiModem configuration program.
  125.     REGISTER.FRM  - Registration form for BIBASS SOFTWARE programs.
  126.     DISTRIB.TXT   - Listing of Distribution BBS's for BiBass Software.
  127.  
  128.  
  129.                                      Page 2
  130.       BISEARCH - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  131.  
  132.     - COPYRIGHT AND LICENSE INFORMATION
  133.  
  134.     BISEARCH and its  documentation  are Copyright(C) 1992 BiBass Software,
  135.     all rights reserved worldwide.  They   may  not  be  circulated  in any
  136.     incomplete or modified  form,  nor  sold  for profit,  without  written
  137.     permission of the  author.   The  use  of  BISEARCH  is  subject to the
  138.     following terms:
  139.  
  140.     PERSONAL USE.  Individuals who use BISEARCH must register their copy if
  141.     they find the program useful.  A registration form is provided for your
  142.     convenience.  If you want to be sure  of  obtaining  the LATEST version
  143.     of  BISEARCH, you can download the archive file BSxxx.ZIP  from  one of
  144.     the distribution sites listed in the file "DISTRIB.TXT".
  145.  
  146.     If you have any questions or comments about BISEARCH, please write.
  147.  
  148.                    Address all correspondence to the author:
  149.  
  150.                                    Kevin Bass
  151.                                Route 3 Box 368A-1
  152.                            Quinlan, Texas  75474  USA
  153.  
  154.     or contact me at my BBS:
  155.  
  156.                                   KEV'S KORNER
  157.                                  (903) 883-4753
  158.                                  Fido: 1:19/107
  159.                                SLNet: 250:302/233
  160.  
  161.     DISCLAIMER: You undertake to use BISEARCH at your own risk.  The author
  162.     assumes no liability for damages of  any kind resulting from the use of
  163.     BISEARCH.
  164.  
  165.  
  166.  
  167.  
  168.     - REQUIREMENTS
  169.  
  170.     * MS-DOS 3.1 or higher.
  171.     * Searchlight 2.0 or higher.
  172.     * BiModem 1.24 or higher.
  173.  
  174.  
  175.  
  176.  
  177.     - SETTING UP BISEARCH
  178.  
  179.     1.  Place a copy of BIMODEM.CFG in each nodes home directory.
  180.  
  181.     2.  Place BIMODEM.COM,  BICONFIG.COM,   and  BSxxx.EXE  in  DOSes PATH.
  182.         BIMODEM.COM and  BICONFIG.COM  can  be  found in the latest copy of
  183.         BiModem  (BIMOD124.ZIP).   Place  BISEARCH.KEY  and BISEARCH.HLP in
  184.         same directory as BSxxx.EXE.
  185.  
  186.     3.  BISEARCH configures  most of BIMODEM.CFG  every  time   it  is run.
  187.         However, you will need to make a few changes if you meet any of the
  188.         following criteria   (NOTE:  Make  sure you are in your  nodes home
  189.         directory and run BICONFIG to make these changes.  Do this for each
  190.         node that will be running BISEARCH):
  191.  
  192.  
  193.  
  194.                                      Page 3
  195.       BISEARCH - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  196.  
  197.     * If you encounter a lot of NAKS during transfers and *ARE NOT* running
  198.        under a  multi-tasking   software   such  as  DESQview or DoubleDos,
  199.        select  the  "GENERAL OPTIONS" area  and  edit  the fields  "Replace
  200.        Timer Interrupt  (Y/N)"  and "Replace Keyboard Interrupt  (Y/N)"  so
  201.        that they say "Y".
  202.  
  203.     * If you  have  a V.32 compatible modem, select the  "TERMINAL OPTIONS"
  204.       area and  edit the field "Modem Type"  so  that  it says "F" for Full
  205.       Duplex.  If you have a Dual Standard  modem edit it so  that  it says
  206.       "D" for   Dual Standard.  It currently is set at "H" for Half Duplex.
  207.       HST's can only transfer in both ways at 2400 baud or less.  A V.32 or
  208.       Dual Standard can transfer in both ways at any baud rate.
  209.  
  210.       If you  have a MNP or have locked  your  comport,  set  the  "CTS/RTS
  211.       hardware flow control (Y/N)" field to "Y".
  212.  
  213.       If you want to base carrier loss on a drop of the carrier detect line
  214.       from the  modem,  set the "Signal Loss of carrier on  Carrier  Detect
  215.       (Y/N)" field to "Y".
  216.  
  217.       If you  want  to  base  carrier  loss on a drop of the data set ready
  218.       line, set the "Signal Loss of carrier  on Data Set Ready (Y/N)" field
  219.       to "Y".
  220.  
  221.     4.  Since Searchlight Passwords can't  be decrypted, you   will need to
  222.         create  a  file called "BISEARCH.PWD" in each nodes home directory,
  223.         listing files  that  are  password  protected on your BBS and their
  224.         password.  This file can contain   up   to 500 entries.   Any files
  225.         uploaded after BISEARCH is installed will be added  to BISEARCH.PWD
  226.         if a  password is provided with the file.  The syntax for this file
  227.         is the following:
  228.  
  229.                 FilePath,Password(C/R L/F)
  230.  
  231.                 EXAMPLE:
  232.  
  233.                 BS200.ZIP,NICE PROGRAM
  234.                 JOEBLOW.ZIP,MISSING
  235.  
  236.     5.  Make an ABORT subdirectory off  each  one  of  the  directories you
  237.         allow files   to  be  uploaded to.  This is where  BiModem will put
  238.         aborted transfers.
  239.  
  240.     6.  Edit your AUTOEXEC.BAT so it contains the SLBBS environment string.
  241.         EXAMPLE:  SET SLBBS=C:\BBS
  242.  
  243.  
  244.                           - DOORS.DEF CONFIGURATION -
  245.  
  246.     1;0;1;<access level>;BiSearch - BiModem interface;.;BSxxx
  247.  
  248.  
  249.                              - MENU COMMAND SETUP -
  250.  
  251.        1.  Command Name ................ BiSearch
  252.     *  2.  Command Key .................
  253.        3.  Description ................. BiModem Transfer Area
  254.     *  4.  Minimum Access Level ........
  255.     *  5.  Maximum Access Level ........
  256.     *  6.  Required Attributes .........
  257.     *  8.  Preference Attributes .......
  258.  
  259.                                      Page 4
  260.       BISEARCH - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  261.  
  262.     *  9.  Help Levels .................
  263.       10.  Door Command ................ BSxxx
  264.       11.  Directory Path .............. [leave blank]
  265.       12.  Communication Support ....... Standard
  266.       13.  Abort Method ................ Terminate
  267.       14.  Write Protection ............ No
  268.       15.  Parameter File .............. None
  269.       16.  Pause After Door ............ No
  270.  
  271.     * Your decision
  272.  
  273.  
  274.                              ** NOTE: Important **
  275.  
  276.     If you run more then one node, you  will  need  to  run BISEARCH from a
  277.     batch file.  However, you will need to set the SLBBS environment string
  278.     for that node first.
  279.  
  280.     EXAMPLE:
  281.  
  282.     SET SLBBS=C:\BBS2
  283.     BSxxx.EXE
  284.  
  285.  
  286.  
  287.  
  288.     - BISEARCH HELP FILE
  289.  
  290.     BiSearch comes with  a  default help file (BISEARCH.HLP).  You may edit
  291.     this file to   say  anything  you  want.    BiSearch   will   recognize
  292.     Searchlight color codes and the '%%FILENAME' directive,  so you may use
  293.     these.  The file can be as long as you want.
  294.  
  295.  
  296.  
  297.  
  298.     - HOW DO I REGISTER MY COPY OF BISEARCH?
  299.  
  300.     If  you  use  BISEARCH   longer  than   30 days,  you need  to register
  301.     your copy.  Please fill out the registration  form (REGISTER.FRM)  and
  302.     send to me along  with your payment.  Please contact me  via modem when
  303.  
  304.     you have  sent   the    payment   off  so I can be  expecting it.  Upon
  305.     receiving your registration fee I will create a registered KEY file for
  306.     you to  download from  my BBS.  If you are FIDOnet or SLnet compatible,
  307.     I will NETmail your key  to you.    It  will  contain your registration
  308.     number and BBS Name.
  309.  
  310.  
  311.  
  312.  
  313.     - ACKNOWLEDGMENTS
  314.  
  315.     *  Turbo Pascal is a trademark of Borland International, Inc.
  316.     *  Searchlight is  a trademark of Searchlight Software by Frank LaRosa.
  317.     *  IBM is a trademark of International Business Machine Corporation.
  318.     *  MS-DOS is a trademark of MicroSoft Corporation.
  319.     *  BiModem is a trademark of Erick Labs.
  320.  
  321.  
  322.  
  323.  
  324.                                      Page 5
  325.       BISEARCH - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  326.